/*
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 */
package erwiki.plugins;

import java.text.MessageFormat;
import java.util.Collection;
import java.util.Map;

import org.apache.commons.lang3.math.NumberUtils;
import org.elwiki_data.WikiPage;
import org.osgi.framework.FrameworkUtil;

import erwiki.api.core.Engine;
import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.pages.PageManager;
import erwiki.api.plugin.PluginManager;
import erwiki.api.preferences.Preferences;

/**
 * Плагин ErWiki. Перечисляет все страницы, содержащие ссылки на неопределенные страницы (страницы,
 * содержащие неработающие ссылки).
 * <p>
 * Параметры плагина: НЕТ
 * 
 * @author An original idea from Gregor Hagedorn.
 */
public class ReferringUndefinedPagesPlugin extends AbstractReferralPlugin {

	/**
	 * Имя параметра задающего максимальное число выводимых элементов. Значение <tt>{@value}</tt>.
	 */
	public static final String PARAM_MAX = "max";

	/**
	 * Имя параметра для настройки текста, который будет отображаться при превышении максимального
	 * количества элементов. Значение <tt>{@value</tt>.
	 */
	public static final String PARAM_EXTRAS = "extras";

	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		super.initialize(context, params);

		try {
			Engine engine = context.getEngine();
			PageManager pageManager = engine.getManager(PageManager.class);

			/* Разбор параметров.
			 */
			int items = NumberUtils.toInt(params.get(PARAM_MAX), ALL_ITEMS);
			String extras = params.get(PARAM_EXTRAS);
			if (extras == null) {
				PluginManager pluginManager = engine.getManager(PluginManager.class);
				extras = pluginManager.getString(Preferences.getLocale(),
						FrameworkUtil.getBundle(this.getClass()), "referringundefinedpagesplugin.more");
			}

			Collection<WikiPage> referrers = pageManager.getReferrersToUncreatedPages();

			// :FVK: result = super.filterAndSortCollection( result );
			String wikitext = wikitizePageCollection(referrers, m_separator, items);

			StringBuilder resultHTML = new StringBuilder();
			resultHTML.append(makeHTML(context, wikitext));

			// добавить еще.... текст
			if (items < referrers.size() && items > 0) {
				Object[] args = { "" + (referrers.size() - items) };
				extras = MessageFormat.format(extras, args);

				resultHTML.append("<br/>" + extras + "<br/>");
			}
			return resultHTML.toString();
		} catch (Exception e) {
			throw new PluginException(e);
		}
	}

}
